$OpenBSD: README-main,v 1.10 2015/07/07 14:44:59 sthen Exp $

+-----------------------------------------------------------------------
| Running ${FULLPKGNAME} on OpenBSD
+-----------------------------------------------------------------------

Notes about Icinga2
===================

Icinga2 is not a drop-in replacement for Icinga (or Nagios)!

Read the "Migration from Icinga 1.x" and the "Differences between Icinga
1.x and 2" sections in the documentation.

A migration script exists (see the "icinga2-migration" package), but it
has several limitations (see the Known Caveats section in the information
at https://github.com/Icinga/icinga2-migration).


Getting Started
===============

The main documentation for Icinga2 is provided in markdown format.
See ${LOCALBASE}/share/doc/icinga2/markdown or at
http://docs.icinga.org/icinga2/latest/doc.

The included sample configuration carries out some simple checks
on the local machine; these should work as-is.

You may check your configuration file format before starting Icinga:

   # su -m _icinga -c "${LOCALBASE}/sbin/icinga2 daemon -C"

This will parse all configuration files and warn about any problems
which have been identified.

Enable icinga2 at boot and start it as usual:

   # rcctl enable icinga2
   # rcctl start icinga2

Web User-Interfaces
===================

A new web-based user interface for Icinga2 is in beta, instructions will
be added to this file in the future. Until its release you can use the
classic or the API based user interfaces, please consult the upstream
documentation and the README for icinga 1.x.
